<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html lang='en'>
  <head>
    <title>KRPC</title>
    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
    <link href='../css/style.css' media='screen' rel='stylesheet' type='text/css'>
    <script type='text/javascript'>
      //<![CDATA[
        function popupCode(url) {
          window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
        }
        
        function toggleCode(id) {
          var code = document.getElementById(id)
        
          code.style.display = code.style.display != 'block' ? 'block' : 'none'
          return true
        }
        
        // Make codeblocks hidden by default
        document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
      //]]>
    </script>
  </head>
  <body class='page'>
    <div class='class' id='wrapper'>
      <div class='header'>
        <h1 class='name'>
          <span class='type'>module</span>
          KRPC
        </h1>
        <ol class='paths'>
          <li>
            <a target="docwin" href="../files/lib/krpc_rb.html">lib/krpc.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/KRPC_pb_rb.html">lib/krpc/KRPC.pb.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/attributes_rb.html">lib/krpc/attributes.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/client_rb.html">lib/krpc/client.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/connection_rb.html">lib/krpc/connection.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/decoder_rb.html">lib/krpc/decoder.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/doc_rb.html">lib/krpc/doc.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/encoder_rb.html">lib/krpc/encoder.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/error_rb.html">lib/krpc/error.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/gen_rb.html">lib/krpc/gen.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/protobuf_utils_rb.html">lib/krpc/protobuf_utils.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/repl_tools_rb.html">lib/krpc/repl_tools.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/service_rb.html">lib/krpc/service.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/streaming_rb.html">lib/krpc/streaming.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/types_rb.html">lib/krpc/types.rb</a>
          </li>
          <li class='other'>
            <a target="docwin" href="../files/lib/krpc/version_rb.html">lib/krpc/version.rb</a>
          </li>
          <li>
            <a class='show' href='#' onclick='this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false'>show all</a>
          </li>
        </ol>
      </div>
      <div id='content'>
        <div id='text'>
          <div id='description'></div>
          <div id='method-list'>
            <h2>Methods</h2>
            <h3>Public Class</h3>
            <ol>
              <li><a target="docwin" href="#method-c-connect">connect</a></li>
            </ol>
          </div>
          <div id='context'>
          </div>
          <div id='class-list'>
            <h2>Classes and Modules</h2>
            <ol>
              <li><a target="docwin" href="KRPC/Attributes.html">KRPC::Attributes</a></li>
              <li><a target="docwin" href="KRPC/Decoder.html">KRPC::Decoder</a></li>
              <li><a target="docwin" href="KRPC/Doc.html">KRPC::Doc</a></li>
              <li><a target="docwin" href="KRPC/Encoder.html">KRPC::Encoder</a></li>
              <li><a target="docwin" href="KRPC/Gen.html">KRPC::Gen</a></li>
              <li><a target="docwin" href="KRPC/PB.html">KRPC::PB</a></li>
              <li><a target="docwin" href="KRPC/ProtobufUtils.html">KRPC::ProtobufUtils</a></li>
              <li><a target="docwin" href="KRPC/REPLTools.html">KRPC::REPLTools</a></li>
              <li><a target="docwin" href="KRPC/Services.html">KRPC::Services</a></li>
              <li><a target="docwin" href="KRPC/Streaming.html">KRPC::Streaming</a></li>
              <li><a target="docwin" href="KRPC/Types.html">KRPC::Types</a></li>
              <li><a target="docwin" href="KRPC/ArgumentErrorSig.html">KRPC::ArgumentErrorSig</a></li>
              <li><a target="docwin" href="KRPC/ArgumentsNumberErrorSig.html">KRPC::ArgumentsNumberErrorSig</a></li>
              <li><a target="docwin" href="KRPC/Client.html">KRPC::Client</a></li>
              <li><a target="docwin" href="KRPC/Connection.html">KRPC::Connection</a></li>
              <li><a target="docwin" href="KRPC/ConnectionError.html">KRPC::ConnectionError</a></li>
              <li><a target="docwin" href="KRPC/RPCConnection.html">KRPC::RPCConnection</a></li>
              <li><a target="docwin" href="KRPC/RPCError.html">KRPC::RPCError</a></li>
              <li><a target="docwin" href="KRPC/StreamConnection.html">KRPC::StreamConnection</a></li>
              <li><a target="docwin" href="KRPC/ValueError.html">KRPC::ValueError</a></li>
            </ol>
          </div>
          <div id='section'>
            <div id='constants-list'>
              <h2>Constants</h2>
              <div class='name-list'>
                <table summary='Constants'>
                  <tr class='top-aligned-row context-row'>
                    <td class='context-item-name'>TypeStore</td>
                    <td>=</td>
                    <td class='context-item-value'>Types::TypeStore</td>
                    <td>&nbsp;</td>
                    <td class='context-item-desc'></td>
                  </tr>
                  <tr class='top-aligned-row context-row'>
                    <td class='context-item-name'>VERSION</td>
                    <td>=</td>
                    <td class='context-item-value'>"0.2.0"</td>
                    <td>&nbsp;</td>
                    <td class='context-item-desc'></td>
                  </tr>
                </table>
              </div>
            </div>
            <div id='methods'>
              <h2>Public Class methods</h2>
              <div class='method public-class' id='method-method-c-connect'>
                <a name='method-c-connect'></a>
                <div class='synopsis'>
                  <span class='name'>connect</span>
                  <span class='arguments'>(*args, &block)</span>
                </div>
                <div class='description'>
                  
                  <p>Connect to a kRPC server, generate services API and return <a
                  href="KRPC/Client.html">Client</a> object. If the block is given, then
                  it&#39;s called passing <a href="KRPC/Client.html">Client</a> object and
                  the connection to kRPC server is closed at the end of the block.</p>
                </div>
                <div class='source'>
                  <a class='source-toggle' href='#' onclick="toggleCode('method-c-connect-source'); return false">
                    [show source]
                  </a>
                  <pre id='method-c-connect-source'><span class="ruby-comment"># File lib/krpc.rb, line 10</span>&#x000A;<span class="ruby-keyword">def</span> <span class="ruby-identifier">connect</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A;  <span class="ruby-constant">Client</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>).<span class="ruby-identifier">connect!</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)&#x000A;<span class="ruby-keyword">end</span></pre>
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>
      <div id='footer-push'></div>
    </div>
    <div id='footer'>
      <a target="docwin" href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
    </div>
  </body>
</html>
